view/com.zedalpha.shadowgadgets.view

Package-level declarations

Types

annotation class ExperimentalShadowGadgets

General, all-purpose annotation for any public API that may change.

class MaterialShapeDrawableViewPathProvider : ViewPathProvider

An implementation of ViewPathProvider that tries to set the Path from a MaterialShapeDrawable in the target's background.

ShadowColorsBlender

class ShadowColorsBlender(context: Context)

Helper class that blends the two native shadow colors into a single value appropriate for use with outlineShadowColorCompat.

ShadowException

@ExperimentalShadowGadgets

class ShadowException(message: String) : RuntimeException

General Exception class for known possible error states.

ShadowGadgets

@ExperimentalShadowGadgets

object ShadowGadgets

Helper object that allows for sensible namespacing of standalone or otherwise unique miscellanea.

ShadowMode

@ExperimentalShadowGadgets

enum ShadowMode : Enum<ShadowMode>

The possible shadow modes.

ShadowPlane

enum ShadowPlane : Enum<ShadowPlane>

Options for locations in the View hierarchy's draw routine where a target's library shadow can be inserted.

ViewPathProvider

fun interface ViewPathProvider

An interface through which to set the clip Path for irregularly shaped Views on API levels 30 and above.

Properties

clipOutlineShadow

var View.clipOutlineShadow: Boolean

The current state of the clipped shadow fix for the receiver View.

forceOutlineShadowColorCompat

var View.forceOutlineShadowColorCompat: Boolean

Determines whether the color compat mechanism should be forced if the current API level is 28 or above.

forceShadowLayer

var View.~~forceShadowLayer~~: Boolean

A patch fix for potential clip defects on API levels 24..28, when a target's parent ViewGroup has a non-identity matrix applied.

MaterialComponentsViewPathProvider

val ~~MaterialComponentsViewPathProvider~~: ViewPathProvider

An implementation of ViewPathProvider that tries to set the Path from a MaterialShapeDrawable in the target's background.

outlineShadowColorCompat

@get:ColorInt

var View.outlineShadowColorCompat: Int

The current color compat value for the receiver View.

pathProvider

var View.pathProvider: ViewPathProvider?

The ViewPathProvider used by clipOutlineShadow for irregular shapes on API levels 30+.

shadowMode

@ExperimentalShadowGadgets

val View.shadowMode: ShadowMode

The current ShadowMode of the receiver's shadow.

shadowPlane

var View.shadowPlane: ShadowPlane

The current ShadowPlane for the receiver View's library shadow.

Functions

doOnShadowModeChange

@ExperimentalShadowGadgets

fun View.doOnShadowModeChange(action: View.(mode: ShadowMode) -> Unit?)

Callback for ShadowMode changes. The target View is passed as the receiver for action, allowing for unqualified access to its members.

resetShadow

@ExperimentalShadowGadgets

fun View.resetShadow()

Convenience for completely resetting a target's shadow state, removing the library shadow if present, and restoring the (presumably broken) native one.

updateShadow

@ExperimentalShadowGadgets

fun View.updateShadow(block: View.() -> Unit)

Allows for efficient modification of multiple shadow properties at once, pausing potentially redundant internal operations until block completes. This functionality is particularly helpful in recycling Adapters that set more than one shadow property.